POST: /productOrder
url
https://nonprod.cwp.esb.cloud.lla.com/dev/sgo-ux-cwp/sgo-ux/v1/{businessId}/productOrder
Key Considerations for order provisioning to enable tradeIn Functionality
- TradeIn functionality is applicable only for Handset products with PCH CommandId, where productOrderItem.product."@type" == "Handset" and productOrderItem.product.productCharacteristic..name == "commandId" and productOrderItem.product.productCharacteristic..value == "PCH"
- TradeIn is applicable for POSTPAID products for B2C Customers.
- handsetBrand, handsetModel, tradeInIndicator, tradeInAmount are the new fields expected from SGO.
- To enable the tradeIn Functionality SGO should send tradeInIndicator as Y, then only ESB will consider this request as tradeIn Request. If tradeInIndicator is Y then it is assumed that all business unit parameters are already validated and ok for tradeIn and ESB will not validate further whether the tradeIn parameters are set to Y or not.
- tradeInAmount is the final amount sent to ESB which is updated in PAN_TRADIN_UPFRT_PAY under prfgroup and sent to liberate.
- ChargeToBill which SGO currently sends under ItemPrice.price.taxIncludedAmount is sent as is and no changes are performed on ESB side.
- tradeInAmount from SGO is always greater than 0.
- If tradeInIndicator is other than Y, no changes are implemented in ESB and existing functionalities would execute as is in ESB.
- ESB doesn't perform any validation on handsetBrand and handsetModel sent from SGO.
Request Body
{
"billingAccount": {
"id": "322473410000"
},
"productOrderItem": [
{
"action": "add",
"product": {
"isBundle": false,
"productCharacteristic": [
{
"name": "simSerialPrefix",
"valueType": "string",
"value": "8950701"
},
{
"name": "simCardNo",
"valueType": "string",
"value": "0000006952119"
},
{
"name": "MSISDN",
"valueType": "string",
"value": "69884740"
}
],
"@type": "Package"
},
"@type": "ProductOrderItem",
"id": "MP_1186",
"quantity": 1
},
{
"id": "190046",
"quantity": 1,
"action": "add",
"product": {
"isBundle": false,
"productCharacteristic": [
{
"valueType": "string",
"value": "PCH",
"name": "commandID"
}
],
"@type": "GenericAddonProduct"
},
"productOrderItemRelationship": [
{
"id": "MP_1186",
"relationshipType": "Parent"
}
],
"@type": "ProductOrderItem"
},
{
"action": "add",
"product": {
"isBundle": false,
"@type": "Plan"
},
"productOrderItemRelationship": [
{
"id": "MP_1186",
"relationshipType": "Parent"
}
],
"@type": "ProductOrderItem",
"id": "MD_4149",
"quantity": 1
},
{
"quantity": 1,
"action": "add",
"productOrderItemRelationship": [
{
"id": "MP_1186",
"relationshipType": "Parent"
}
],
"itemPrice": [
{
"name": "salePrice",
"priceType": "sold",
"price": {
"taxIncludedAmount": {
"value": 0
}
}
},
{
"name": "deposit",
"price": {
"taxIncludedAmount": {
"value": 0
}
}
}
],
"product": {
"productCharacteristic": [
{
"name": "deviceID",
"valueType": "string",
"value": ""
},
{
"name": "commandID",
"valueType": "string",
"value": "PCH"
},
{
"name": "promoCode",
"valueType": "string",
"value": ""
},
{
"name": "imei",
"valueType": "string",
"value": ""
},
{
"name": "handsetBrand",
"valueType": "string",
"value": "Apple"
},
{
"name": "handsetModel",
"valueType": "string",
"value": "iPhone 12"
},
{
"name": "tradeInAmount",
"valueType": "string",
"value": "60"
},
{
"name": "tradeInIndicator",
"valueType": "string",
"value": "Y"
},
{
"value": 0,
"name": "additionalDiscount",
"valueType": "integer"
},
{
"value": 0,
"name": "saleDiscount",
"valueType": "integer"
},
{
"name": "contractDuration",
"valueType": "integer",
"value": 18
},
{
"name": "customerOwned",
"value": "Y"
},
{
"name": "optForInstallment",
"valueType": "string",
"value": "N"
},
{
"name": "upfrontPayment",
"valueType": "string",
"value": "0"
}
],
"@type": "Handset",
"isBundle": false
},
"@type": "ProductOrderItem",
"id": "101044"
}
],
"orderCharacteristics": {
"numberAreaCode": "GSM1",
"orderType": "prepaid_to_postpaid_int_port",
"contractId": "2027211",
"salesRepId": "92638",
"depttCode": "MOVIL",
"siteCode": "GSM",
"sourceOfApplication": "EH",
"exchangeId": "GSM1",
"servicePin": "1234",
"cisEmpId": "92638",
"donornetwork": "CWP",
"prepaidToPostpaidSamesim": "Y",
"serNumberStatus": "RESERVED"
},
"serviceAddress": {
"addrType": "A",
"addrLine1": "Principal",
"addrLine2": "BARRIADA SANTA ISABEL",
"addrLine3": "CHEPO",
"addrLine4": "CHEPO",
"addrLine5": "PANAMA"
}
}
Response
{
"id": "PB1434B",
"state":" "
"billingAccount": {
"id": "322473410000"
},
"productOrderItem": [
{
"action": "add",
"product": {
"isBundle": false,
"productCharacteristic": [
{
"name": "simSerialPrefix",
"valueType": "string",
"value": "8950701"
},
{
"name": "simCardNo",
"valueType": "string",
"value": "0000006952119"
},
{
"name": "MSISDN",
"valueType": "string",
"value": "69884740"
}
],
"@type": "Package"
},
"@type": "ProductOrderItem",
"id": "MP_1186",
"quantity": 1
},
{
"id": "190046",
"quantity": 1,
"action": "add",
"product": {
"isBundle": false,
"productCharacteristic": [
{
"valueType": "string",
"value": "PCH",
"name": "commandID"
}
],
"@type": "GenericAddonProduct"
},
"productOrderItemRelationship": [
{
"id": "MP_1186",
"relationshipType": "Parent"
}
],
"@type": "ProductOrderItem"
},
{
"action": "add",
"product": {
"isBundle": false,
"@type": "Plan"
},
"productOrderItemRelationship": [
{
"id": "MP_1186",
"relationshipType": "Parent"
}
],
"@type": "ProductOrderItem",
"id": "MD_4149",
"quantity": 1
},
{
"quantity": 1,
"action": "add",
"productOrderItemRelationship": [
{
"id": "MP_1186",
"relationshipType": "Parent"
}
],
"itemPrice": [
{
"name": "salePrice",
"priceType": "sold",
"price": {
"taxIncludedAmount": {
"value": 0
}
}
},
{
"name": "deposit",
"price": {
"taxIncludedAmount": {
"value": 0
}
}
}
],
"product": {
"productCharacteristic": [
{
"name": "deviceID",
"valueType": "string",
"value": ""
},
{
"name": "commandID",
"valueType": "string",
"value": "PCH"
},
{
"name": "promoCode",
"valueType": "string",
"value": ""
},
{
"name": "imei",
"valueType": "string",
"value": ""
},
{
"name": "handsetBrand",
"valueType": "string",
"value": "Apple"
},
{
"name": "handsetModel",
"valueType": "string",
"value": "iPhone 12"
},
{
"name": "tradeInAmount",
"valueType": "string",
"value": "60"
},
{
"name": "tradeInIndicator",
"valueType": "string",
"value": "Y"
},
{
"value": 0,
"name": "additionalDiscount",
"valueType": "integer"
},
{
"value": 0,
"name": "saleDiscount",
"valueType": "integer"
},
{
"name": "contractDuration",
"valueType": "integer",
"value": 18
},
{
"name": "customerOwned",
"value": "Y"
},
{
"name": "optForInstallment",
"valueType": "string",
"value": "N"
},
{
"name": "upfrontPayment",
"valueType": "string",
"value": "0"
}
],
"@type": "Handset",
"isBundle": false
},
"@type": "ProductOrderItem",
"id": "101044"
}
],
"orderCharacteristics": {
"numberAreaCode": "GSM1",
"orderType": "prepaid_to_postpaid_int_port",
"contractId": "2027211",
"salesRepId": "92638",
"depttCode": "MOVIL",
"siteCode": "GSM",
"sourceOfApplication": "EH",
"exchangeId": "GSM1",
"servicePin": "1234",
"cisEmpId": "92638",
"donornetwork": "CWP",
"prepaidToPostpaidSamesim": "Y",
"serNumberStatus": "RESERVED"
},
"serviceAddress": {
"addrType": "A",
"addrLine1": "Principal",
"addrLine2": "BARRIADA SANTA ISABEL",
"addrLine3": "CHEPO",
"addrLine4": "CHEPO",
"addrLine5": "PANAMA"
}
}